DocumentManagementAPI Methods
An object defining methods for the DocumentManagementAPI class.
CancelBranch(requestVersion, cancellationToken, telemetryCollectorHolder)
Cancels a specified branch in the document management system.
Parameters:
requestVersion (required): CancelBranchRequest
The request object containing the details of the branch to be canceled.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the branch was successfully canceled.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteFiles(deleteFilesRequest, cancellationToken, telemetryCollectorHolder)
Deletes multiple files based on the provided request.
Parameters:
deleteFilesRequest (required): DeleteFilesRequest
The request object containing details for file deletion.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Indicates success or failure of the deletion.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetDMObjectsFromPaths(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves document management objects from multiple specified paths.
Parameters:
requestObject (required): GetDMObjectsFromPathsRequest
The request object containing the paths details to retrieve objects from.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectsResponse>>
Returns a wrapped response containing the document management objects retrieved from the paths.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
RenameObject(requestObject, cancellationToken, telemetryCollectorHolder)
Renames an object based on the provided request.
Parameters:
requestObject (required): RenameObjectRequest
The request object containing details for the rename operation.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Indicates success or failure of the rename operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DownloadAsync(downloadUrl, cancellationToken, telemetryCollectorHolder)
Downloads data from a specified URL in the document management system.
Parameters:
downloadUrl (required): string
The URL from which the data is to be downloaded.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<byte>
Returns the raw bytes of the downloaded data.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetRecentObjectsAsync(cancellationToken, telemetryCollectorHolder)
Retrieves the most recent objects from the document management system.
Parameters:
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDMObjectResponse>
Returns a response containing the most recent document management objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
AddObjectsToFavoritesAsync(secretKeys, cancellationToken, telemetryCollectorHolder)
Adds the specified objects to the user's favorites.
Parameters:
secretKeys (required): List<string>
A list of secret keys for the objects to be added to favorites.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<bool>
Indicates success or failure of the operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteFolder(deleteFolderRequest, cancellationToken, telemetryCollectorHolder)
Deletes a specified folder from the document management system.
Parameters:
deleteFolderRequest (required): DeleteFolderRequest
The request object containing the details of the folder to be deleted.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the folder was successfully deleted.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetFolderItemsAsync(loadOptions, fetchedObjectType, secretKey, cancellationToken, telemetryCollectorHolder)
Retrieves items within a specified folder.
Parameters:
loadOptions (required): LoadOptions
Options for loading the folder items.
fetchedObjectType (required): FetchedObjectType
The type of objects to fetch.
secretKey (required): string
The secret key of the folder.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDMObjectsResponse>
Contains the folder items.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
UpdateTags(requestObject, cancellationToken, telemetryCollectorHolder)
Updates tags for specified objects based on the provided request.
Parameters:
requestObject (required): UpdateTagsRequest
The request object containing details for tag updates.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Indicates success or failure of the update operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetGridContextAsync(secretKey, cancellationToken, telemetryCollectorHolder)
Retrieves the grid context for a specified secret key in the document management system.
Parameters:
secretKey (required): string
The secret key associated with the grid context to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GridContextResponse>
Returns a response containing the grid context for the specified secret key.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Upload(data, uploadParts, cancellationToken, telemetryCollectorHolder)
Uploads a byte array as a file using the specified upload parts.
Parameters:
data (required): byte[]
The byte array representing the file data.
uploadParts (required): List<UploadPart>
A list ofUploadPartobjects that define the parts of the upload.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: bool
Indicates success or failure of the upload.
This is a sync method. Method runs synchronously.
BindObject(bindPermissionGroupWithObjectRequest, cancellationToken, telemetryCollectorHolder)
Binds a permission group to a specified object in the document management system.
Parameters:
bindPermissionGroupWithObjectRequest (required): BindPermissionGroupWithObjectRequest
The request object containing the details of the permission group and the object to be bound.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<PermissionGroup>
Returns the permission group that was successfully bound to the specified object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetTagsOfObjects(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves tags associated with specified objects.
Parameters:
requestObject (required): GetTagsOfObjectsRequest
The request object containing details for tag retrieval.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetTagsOfObjectsResponse>>
Contains the tags of the objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CopyObjects(requestObject, cancellationToken, telemetryCollectorHolder)
Copies objects based on the provided request.
Parameters:
requestObject (required): CopyObjectsRequest
The request object containing details for the copy operation.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<CopyObjectsResponse>>
Contains the results of the copy operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetRelationFilesOfTheFileAsync(objectKeys, objectSecret, cancellationToken, telemetryCollectorHolder)
Retrieves related files for the specified object.
Parameters:
objectKeys (required): string
The keys of the object for which to retrieve related files.
objectSecret (required): DMObjectSecret
The secret of the object.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<List<GetDMObjectResponse>>
A list of related files.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetDownloadUrl(secretKey, fileName, cancellationToken, telemetryCollectorHolder)
Retrieves the download URL for a specified file in the document management system.
Parameters:
secretKey (required): string
The secret key associated with the file to be downloaded.
fileName (required): string
The name of the file to be downloaded.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDownloadUrlResponse>
Returns a response containing the download URL for the specified file.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteObjectFromFavoritesAsync(secretKey, dmObjectSecret, cancellationToken, telemetryCollectorHolder)
Removes a specified object from the favorites in the document management system.
Parameters:
secretKey (required): string
The secret key associated with the object to be removed from favorites.
dmObjectSecret (required): DMObjectSecret
The object secret containing details of the object to be removed.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<bool>
Returns a boolean indicating whether the object was successfully removed from favorites.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
UnsetAsDefaultContent(requestObject, cancellationToken, telemetryCollectorHolder)
Unsets a specified content from being the default in the document management system.
Parameters:
requestObject (required): UnsetAsDefaultContentRequest
The request object containing the details of the content to be unset as default.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the content was successfully unset as default.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateRepository(requestObject, cancellationToken, telemetryCollectorHolder)
Creates a new repository based on the provided request.
Parameters:
requestObject (required): CreateRepositoryRequest
The request object containing details for repository creation.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectResponse>>
Contains the created repository details.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetSuggestions(getPermissionGroupSuggestionsRequest, cancellationToken, telemetryCollectorHolder)
Retrieves suggestions for permission groups based on specified criteria.
Parameters:
getPermissionGroupSuggestionsRequest (required): GetPermissionGroupSuggestionsRequest
The request object containing the criteria for permission group suggestions.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<List<PermissionGroup>>
Returns a list of suggested permission groups based on the criteria.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
MoveObjects(requestObject, cancellationToken, telemetryCollectorHolder)
Moves objects based on the provided request.
Parameters:
requestObject (required): MoveObjectsRequest
The request object containing details for the move operation.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Indicates success or failure of the move operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
FilesUpload(parts, cancellationToken, telemetryCollectorHolder)
Uploads multiple files using the specified parts.
Parameters:
parts (required): List<FilesUploadPart>
A list ofFilesUploadPartobjects that define the parts of the upload.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: bool
Indicates success or failure of the upload.
This is a sync method. Method runs synchronously.
CreateContent(requestObject, cancellationToken, telemetryCollectorHolder)
Creates content in the document management system.
Parameters:
requestObject (required): CreateObjectRequest
The request object containing the details of the content to be created.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMContentObjectResponse>>
Returns a wrapped response containing the created content object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Upload(data, mimeType, uploadParts, cancellationToken, telemetryCollectorHolder)
Uploads a byte array as a file using the specified upload parts.
Parameters:
data (required): byte[]
The byte array representing the file data.
mimeType (required): string
The MIME type of the file.
uploadParts (required): List<UploadPart>
A list ofUploadPartobjects that define the parts of the upload.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: bool
Indicates success or failure of the upload.
This is a sync method. Method runs synchronously.
CreateShortcut(requestObject, cancellationToken, telemetryCollectorHolder)
Creates a shortcut for specified objects in the document management system.
Parameters:
requestObject (required): CreateShortcutObjectsRequest
The request object containing the details of the shortcut to be created.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<CreateShortcutObjectsResponse>>
Returns a wrapped response indicating the result of the shortcut creation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetFile(secretKey, cancellationToken, telemetryCollectorHolder)
Asynchronously retrieves a file based on the provided secret key.
Parameters:
secretKey (required): string
The secret key of the file to retrieve.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectResponse>>
Returns a task that represents the asynchronous operation, containing the retrieved file details.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteFile(requestObject, cancellationToken, telemetryCollectorHolder)
Asynchronously deletes a file based on the provided request.
Parameters:
requestObject (required): DeleteFileRequest
The request object containing details for the file deletion.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a task that represents the asynchronous operation, indicating success or failure of the deletion.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetFavoritesAsync(managementType, cancellationToken, telemetryCollectorHolder)
Retrieves favorite objects from the document management system.
Parameters:
managementType (required): ManagementType
The type of management for which favorites are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDMObjectsResponse>
Returns a response containing the favorite document management objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CompleteBranch(requestVersion, cancellationToken, telemetryCollectorHolder)
Completes a specified branch in the document management system.
Parameters:
requestVersion (required): CompleteBranchRequest
The request object containing the details of the branch to be completed.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetVersionResponse>>
Returns a wrapped response indicating the result of the branch completion.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateFile(createFileRequest, cancellationToken, telemetryCollectorHolder)
Asynchronously creates a new file based on the provided request.
Parameters:
createFileRequest (required): CreateFileRequest
The request object containing details for the file creation.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectResponse>>
Returns a task that represents the asynchronous operation, containing the details of the created file.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
UnbindObject(unbindPermissionGroupWithObjectRequest, cancellationToken, telemetryCollectorHolder)
Unbinds a permission group from a specified object in the document management system.
Parameters:
unbindPermissionGroupWithObjectRequest (required): UnbindPermissionGroupWithObjectRequest
The request object containing the details of the permission group and the object to be unbound.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<bool>
Returns a boolean indicating whether the unbinding was successful.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetCommitList(requestVersion, cancellationToken, telemetryCollectorHolder)
Retrieves the list of commits for a specified document in the document management system.
Parameters:
requestVersion (required): GetCommitListRequest
The request object containing the details of the document for which commits are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetCommitResponse>>
Returns a wrapped response containing the list of commits for the specified document.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetFolder(secretKey, cancellationToken, telemetryCollectorHolder)
Retrieves a folder based on the provided secret key.
Parameters:
secretKey (required): string
The secret key of the folder to retrieve.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectResponse>>
Contains the folder details.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetDocumentSignatures(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves the signatures for a specified document.
Parameters:
requestObject (required): GetDocumentSignaturesRequest
The request object containing the details of the document for which signatures are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDocumentSignaturesResponse>>
Returns a wrapped response containing the document signatures.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetObjectsContextAsync(secretKeys, excludeParentTrees, excludePermissions, excludeProperties, cancellationToken, telemetryCollectorHolder)
Retrieves the context of objects with additional filtering options.
Parameters:
secretKeys (required): List<string>
A list of secret keys for the objects.
excludeParentTrees (optional): bool?
Whether to exclude parent trees.
excludePermissions (optional): bool?
Whether to exclude permissions.
excludeProperties (optional): bool?
Whether to exclude properties.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetObjectsContextResponse>
Contains the context of the objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteRelationFromFileAsync(objectKeys, objectSecret, relatedObjectKey, relatedObjectSecret, cancellationToken, telemetryCollectorHolder)
Deletes a relation between two files.
Parameters:
objectKeys (required): string
The keys of the primary object.
objectSecret (required): DMObjectSecret
The secret of the primary object.
relatedObjectKey (required): string
The key of the related object to be deleted.
relatedObjectSecret (required): DMObjectSecret
The secret of the related object.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<bool>
Indicates success or failure of the operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
UpdateObjectPermissions(updateObjectPermissionsRequest, cancellationToken, telemetryCollectorHolder)
Updates the permissions associated with a specified object in the document management system.
Parameters:
updateObjectPermissionsRequest (required): UpdateObjectPermissionsRequest
The request object containing the details of the object and the new permissions to be set.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetPermissionsResponse>
Returns a response containing the updated permissions associated with the specified object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetContents(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves multiple contents from the document management system.
Parameters:
requestObject (required): GetContentsRequest
The request object containing the details of the contents to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMContentObjectsResponse>>
Returns a wrapped response containing the retrieved content objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetProperties(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves properties of an object based on the provided request.
Parameters:
requestObject (required): GetPropertiesRequest
The request object containing details for the property retrieval.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<ObjectProperties>>
Contains the properties of the object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetRepositoriesAsync(loadOptions, cancellationToken, telemetryCollectorHolder)
Retrieves repositories from the document management system.
Parameters:
loadOptions (required): LoadOptions
The options specifying how the repositories should be loaded.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDMObjectsResponse>
Returns a response containing the repositories.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SetAsDefaultContent(requestObject, cancellationToken, telemetryCollectorHolder)
Sets a specified content as the default in the document management system.
Parameters:
requestObject (required): SetAsDefaultContentRequest
The request object containing the details of the content to be set as default.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the content was successfully set as default.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetPathsAsync(secretKeys, cancellationToken, telemetryCollectorHolder)
Asynchronously retrieves the paths of the specified document management objects.
Parameters:
secretKeys (required): List<string>
A list of secret keys for the objects whose paths are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<DMObjectsPathResponse>
Returns a task that represents the asynchronous operation, containing the paths of the specified objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateCommit(requestVersion, cancellationToken, telemetryCollectorHolder)
Creates a commit for a specified document in the document management system.
Parameters:
requestVersion (required): CreateCommitRequest
The request object containing the details of the commit to be created.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetUploadPartsResponse>>
Returns a wrapped response indicating the result of the commit creation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetVersionList(requestVersion, cancellationToken, telemetryCollectorHolder)
Retrieves the list of versions for a specified document in the document management system.
Parameters:
requestVersion (required): GetVersionListRequest
The request object containing the details of the document for which versions are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetVersionListResponse>>
Returns a wrapped response containing the list of versions for the specified document.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetObjectPermissions(getObjectPermissionsRequest, cancellationToken, telemetryCollectorHolder)
Retrieves the permissions associated with a specified object in the document management system.
Parameters:
getObjectPermissionsRequest (required): GetObjectPermissionsRequest
The request object containing the details of the object for which permissions are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetPermissionsResponse>
Returns a response containing the permissions associated with the specified object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateFiles(createFileRequest, cancellationToken, telemetryCollectorHolder)
Creates multiple files based on the provided request.
Parameters:
createFileRequest (required): CreateFilesRequest
The request object containing details for file creation.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectsResponse>>
Contains the created files' responses.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateFolderAsync(folderName, folderDescription, parentFolderSecretKey, cancellationToken, telemetryCollectorHolder)
Creates a new folder with the specified name and description.
Parameters:
folderName (required): Dictionary<string, string>
A dictionary containing the name of the folder.
folderDescription (required): Dictionary<string, string>
A dictionary containing the description of the folder.
parentFolderSecretKey (required): string
The secret key of the parent folder.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDMObjectResponse>
Contains the created folder details.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DownloadsAsync(downloadFilesRequest, cancellationToken, telemetryCollectorHolder)
Downloads multiple files from specified URLs in the document management system.
Parameters:
downloadFilesRequest (required): DownloadFilesRequest
The request object containing the URLs of the files to be downloaded.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<DownloadFilesResponse>
Returns a response containing the raw bytes of the downloaded files.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetAllOfObject(getPermissionGroupsOfObjectRequest, cancellationToken, telemetryCollectorHolder)
Retrieves all permission groups associated with a specified object in the document management system.
Parameters:
getPermissionGroupsOfObjectRequest (required): GetPermissionGroupsOfObjectRequest
The request object containing the details of the object for which permission groups are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<List<PermissionGroup>>
Returns a list of permission groups associated with the specified object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetUploadParts(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves upload parts for a document in the document management system.
Parameters:
requestObject (required): GetUploadPartsRequest
The request object containing the details of the upload parts to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetUploadPartsResponse>>
Returns a wrapped response containing the upload parts.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetDownloadUrls(getFilesDownloadUrlsRequest, cancellationToken, telemetryCollectorHolder)
Retrieves download URLs for multiple files in the document management system.
Parameters:
getFilesDownloadUrlsRequest (required): GetDownloadUrlRequest
The request object containing the details of the files for which download URLs are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetDownloadUrlResponse>
Returns a response containing the download URLs for the specified files.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetFilesUploadParts(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves upload parts for multiple files in the document management system.
Parameters:
requestObject (required): GetFilesUploadPartsRequest
The request object containing the details of the files and their upload parts to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetFilesUploadPartsResponse>>
Returns a wrapped response containing the upload parts for the files.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteRepository(requestObject, cancellationToken, telemetryCollectorHolder)
Deletes a repository based on the provided request.
Parameters:
requestObject (required): DeleteRepositoryRequest
The request object containing details for repository deletion.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Indicates success or failure of the deletion.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetTags(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves all tags available in the system.
Parameters:
requestObject (required): GetTagsRequest
The request object containing details for tag retrieval.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetTagsResponse>>
Contains all available tags.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SearchAsync(searchText, objectTypes, searchIn, locationSecretKey, createdBy, modifiedAfter, includeSubChildren, includeRecycleBin, includeFavorites, pagination, cancellationToken, telemetryCollectorHolder)
Asynchronously searches for documents based on the provided search criteria.
Parameters:
searchText (required): string
The text to search for in the documents.
objectTypes (required): List<DMObjectType>
The types of objects to include in the search.
searchIn (required): SearchSourceTypes
The source types to search in.
locationSecretKey (required): string
The secret key of the location to search within.
createdBy (optional): long?
The ID of the user who created the documents.
modifiedAfter (optional): DateTimeOffset?
The date after which the documents were modified.
includeSubChildren (required): bool
Whether to include sub-children in the search.
includeRecycleBin (required): bool
Whether to include items from the recycle bin.
includeFavorites (required): bool
Whether to include favorite items in the search.
pagination (required): Pagination
The pagination details for the search results.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<SearchResponse>
Returns a task that represents the asynchronous operation, containing the search results.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetDMObjectsFromPath(requestObject, cancellationToken, telemetryCollectorHolder)
Retrieves document management objects from a specified path.
Parameters:
requestObject (required): GetDMObjectsFromPathRequest
The request object containing the path details to retrieve objects from.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectsResponse>>
Returns a wrapped response containing the document management objects retrieved from the path.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetObjectsContextAsync(secretKeys, cancellationToken, telemetryCollectorHolder)
Retrieves the context of objects based on the provided secret keys.
Parameters:
secretKeys (required): List<string>
A list of secret keys for the objects.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<GetObjectsContextResponse>
Contains the context of the objects.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetRepository(secretKey, cancellationToken, telemetryCollectorHolder)
Retrieves a repository based on the provided secret key.
Parameters:
secretKey (required): string
The secret key of the repository to retrieve.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectResponse>>
Contains the repository details.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SearchMembers(searchMembersRequest, cancellationToken, telemetryCollectorHolder)
Searches for members in the document management system based on specified criteria.
Parameters:
searchMembersRequest (required): SearchMembersRequest
The request object containing the search criteria for members.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<List<MemberInfoDetail>>
Returns a list of members matching the search criteria.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetContent(secretKey, cancellationToken, telemetryCollectorHolder)
Retrieves content from the document management system using a secret key.
Parameters:
secretKey (required): string
The secret key associated with the content to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetDMObjectResponse>>
Returns a wrapped response containing the retrieved content object.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteShortcut(requestObject, cancellationToken, telemetryCollectorHolder)
Deletes a specified shortcut from the document management system.
Parameters:
requestObject (required): DeleteObjectRequest
The request object containing the details of the shortcut to be deleted.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the shortcut was successfully deleted.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
CreateBranch(requestVersion, cancellationToken, telemetryCollectorHolder)
Creates a branch for a specified document in the document management system.
Parameters:
requestVersion (required): CreateBranchRequest
The request object containing the details of the branch to be created.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetVersionResponse>>
Returns a wrapped response indicating the result of the branch creation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetVersionSuggestion(requestVersion, cancellationToken, telemetryCollectorHolder)
Retrieves version suggestions for a specified document in the document management system.
Parameters:
requestVersion (required): GetVersionSuggestionRequest
The request object containing the details of the document for which version suggestions are to be retrieved.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<GetVersionSuggestionResponse>>
Returns a wrapped response containing the version suggestions for the specified document.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteContent(requestObject, cancellationToken, telemetryCollectorHolder)
Deletes content from the document management system.
Parameters:
requestObject (required): DeleteContentRequest
The request object containing the details of the content to be deleted.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the content was successfully deleted.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
AddRelationToFileAsync(objectKeys, objectSecret, relatedObjectKeys, relatedObjectSecret, subRelationCheck, cancellationToken, telemetryCollectorHolder)
Adds a relation between two files.
Parameters:
objectKeys (required): string
The keys of the primary object.
objectSecret (required): DMObjectSecret
The secret of the primary object.
relatedObjectKeys (required): string
The keys of the related object.
relatedObjectSecret (required): DMObjectSecret
The secret of the related object.
subRelationCheck (required): bool
Whether to check for sub-relations.
cancellationToken (optional): CancellationToken
A token to monitor for cancellation requests.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the operation.
Returns:
Type: Task<bool>
Indicates success or failure of the operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.